Vapi Metadata Authentication ComponentData

Vapi Metadata Authentication ComponentData
Vapi Metadata Authentication ComponentData

The Vapi Metadata Authentication ComponentData schema contains the authentication information of the component along with its fingerprint.

JSON Example
{
    "info": {
        "packages": {
            "packages": {
                "schemes": [
                    {
                        "scheme_type": "string",
                        "session_manager": "string",
                        "scheme": "string"
                    }
                ],
                "services": {
                    "services": {
                        "schemes": [
                            {
                                "scheme_type": "string",
                                "session_manager": "string",
                                "scheme": "string"
                            }
                        ],
                        "operations": {
                            "operations": {
                                "schemes": [
                                    {
                                        "scheme_type": "string",
                                        "session_manager": "string",
                                        "scheme": "string"
                                    }
                                ]
                            }
                        }
                    }
                }
            }
        }
    },
    "fingerprint": "string"
}
info
Required

Authentication information of the component. This includes information about all the namespaces in the component.

string
fingerprint
Required

Fingerprint of the metadata of the component.

Authentication information could change when there is an infrastructure update. Since the data present in Vapi Metadata Authentication ComponentData.info could be quite large, fingerprint provides a convenient way to check if the data for a particular component is updated.

You should store the fingerprint associated with a component. After an update, by invoking the GET /vapi/metadata/authentication/component/{componentId}/fingerprint operation, you can retrieve the new fingerprint for the component. If the new fingerprint and the previously stored fingerprint do not match, clients can then use the GET /vapi/metadata/authentication/component/{componentId} to retrieve the new authentication information for the component.